Micron Document
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| SparkN0de-git | SparkN0de |
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Node / ReticulumProjects / Sideband.git / commits / f64a890


Commit f64a8905e8bfc3c79c6484c947617971c71b2f74

󰉖 Browse tree at this commit

Parents : fc10ced
Author : markqvist <mark@unsigned.io>
Signature : Signature validation error
Date : 2024-06-07T18:31:40+02:00
Committer : GitHub <noreply@github.com>
Date : 2024-06-07T18:31:40+02:00

Update README.md, closes #50

Changes

1 files changed, 6 insertions(+), 2 deletions(-)

M README.md +6 -2

Diff

diff --git a/README.md b/README.md
index 8b831734..fab59919 100644
--- a/README.md
+++ b/README.md
@@ -42,7 +42,7 @@ On all Linux-based operating systems, Sideband is available as a `pip` package.
# a command like one of the following:
pamac install python-pyaudio # Manjaro
-sudo pacman -Sy python-pyaudio # Arch
+sudo pacman -Sy python-pyaudio # Arch
sudo apt install python3-pyaudio # Debian and derivatives
# Install the Sideband application:
@@ -120,7 +120,11 @@ When running Sideband for the first time, a default Reticulum configuration file
## Installation With pipx
-You *can* use the `pipx` tool to install Sideband in an isolated environment, but on Linux you will have to launch Sideband from the command line, or create your own launcher links, since `pipx` does not support desktop integration. Unfortunately, it does not seem like `pipx` will be adding desktop integration in the near future, so restoring the original `pip` tool to its proper behaviour is recommended for now. If you want to use `pipx` anyway, it is as simple as:
+While I wouldn't generally recommend it, you *can* use the `pipx` tool to install Sideband, but on Linux you will have to launch Sideband from the command line, or create your own launcher links, since `pipx` does not support desktop integration. Unfortunately, it does not seem like `pipx` will be adding desktop integration in the near future, so restoring the original `pip` tool to its proper behaviour is recommended for now.
+
+The `pipx` installer also has trouble with including distribution-installed Python packages, so you will need to install additional packages on your system that will allow `pipx` to build required dependencies from source. In general, it will require a working build environment and header files for PortAudio. On Debian and derivatives, this would look something like `sudo apt install build-essential portaudio19-dev`. On Manjaro you would want something like `pamac install base-devel portaudio`.
+
+If you want to use `pipx` anyway, and after the necessary dependencies are installed, you can simply do:
```bash
# Install Sideband on Linux:


──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────